<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<title>simGetArrayParam</title>
<link rel="stylesheet" type="text/css" href="../../style.css">
</head>

<body>

<div align="center">
<table class=allEncompassingTable >
 <tr>
  <td >
<p><a href="../../index.html" TARGET="_top"><img src="../images/homeImg.png"></a></p>

<h1>Regular API function</h1>
<h3 class=subsectionBar><a name="simGetArrayParam" id="simGetArrayParam"></a>simGetArrayParam / sim.getArrayParam</h3>
<table class=apiTable>
<tr class=apiTableTr> 
<td class=apiTableLeftDescr>
Description 
</td> 
<td class=apiTableRightDescr>Retrieves 3 values from an array. See the <a href="../apiConstants.htm#arrayParameters">array parameter identifiers</a>. See also <a href="simSetArrayParam.htm">sim.setArrayParam</a>, <a href="simGetBoolParam.htm">sim.getBoolParam</a>, <a href="simGetInt32Param.htm">sim.getInt32Param</a>, <a href="simGetFloatParam.htm">sim.getFloatParam</a> and <a href="simGetStringParam.htm">sim.getStringParam</a>.<br></td>
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCSyn>
C synopsis
</td> 
<td class=apiTableRightCSyn>simInt simGetArrayParam(simInt parameter,simVoid* parameterValues)<br></td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCParam>C parameters</td> 
<td class=apiTableRightCParam>
<div><strong>parameter</strong>: <a href="../apiConstants.htm#arrayParameters">array parameter identifier</a></div>
<div><strong>parameterValues</strong>: a simFloat pointer  (simVoid is kept for backward compatibility). The 3 values will be copied to that location</div>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftCRet>
C return value
</td> 
<td class=apiTableRightCRet>
<div>-1 if operation was not successful</div>
</td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLSyn>
Lua synopsis
</td> 
<td class=apiTableRightLSyn>table[] parameterValues=sim.getArrayParam(int parameter)<br></td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLParam>Lua parameters</td> 
<td class=apiTableRightLParam>
<div>Similar to the C-function counterpart</div>
<div></div></td> 
</tr> 
<tr class=apiTableTr> 
<td class=apiTableLeftLRet>
Lua return values
</td> 
<td class=apiTableRightLRet>
<div><strong>parameterValues</strong>: a table that holds the returned values</div>
</td> 
</tr> 

<tr class=apiTableTr> 
<td class=remApiTableLeftCParam>
Remote API equiv.
</td> 
<td class=remApiTableRightCParam>
<div>B0-based remote API: <a href="../b0RemoteApi-cpp.htm#simxGetArrayParam">simxGetArrayParam</a></div>
<div>Legacy remote API: <a href="../remoteApiFunctions.htm#simxGetArrayParam">simxGetArrayParam</a></div>
</td> 
</tr> 

</table> 


<br>
</td>
</tr>
</table>
</div>
</body>
</html>
